package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendGoOutRecordAddDTO;
import org.jsola.hr.dto.AttendGoOutRecordUpdateDTO;
import org.jsola.hr.query.AttendGoOutRecordQuery;
import org.jsola.hr.vo.AttendGoOutRecordListVO;
import org.jsola.hr.vo.AttendGoOutRecordVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-外出打卡记录")
public interface IAttendGoOutRecordControllerAPI {

    /**
     * 新增外出打卡记录
     * @param attendGoOutRecordAddDTO 外出打卡记录新增实体
     * @return 外出打卡记录展示对象
     */
    @ApiOperation(value = "新增外出打卡记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendGoOutRecordAddDTO", dataType = "AttendGoOutRecordAddDTO", value = "新增外出打卡记录", paramType = "body")
    })
    Result<AttendGoOutRecordVO> save(AttendGoOutRecordAddDTO attendGoOutRecordAddDTO);


    /**
     * 修改外出打卡记录
     * @param attendGoOutRecordUpdateDTO 外出打卡记录
     * @return 更新数量
     */
    @ApiOperation(value = "修改外出打卡记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendGoOutRecordUpdateDTO", dataType = "AttendGoOutRecordUpdateDTO", value = "修改外出打卡记录", paramType = "body")
    })
    Result<Integer> update(AttendGoOutRecordUpdateDTO attendGoOutRecordUpdateDTO);




    /**
     * 删除单个外出打卡记录，彻底删除
     * @param attendGoOutRecordId 外出打卡记录id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个外出打卡记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendGoOutRecordId", dataType = "String", value = "外出打卡记录id", paramType = "path")
    })
    Result<Integer> delete(String attendGoOutRecordId);


    /**
     * 批量删除外出打卡记录，彻底删除
     * @param attendGoOutRecordIds 外出打卡记录id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除外出打卡记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendGoOutRecordIds", dataType = "String[]", value = "外出打卡记录id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendGoOutRecordIds);


    /**
     * 根据外出打卡记录id查询外出打卡记录详情
     * @param attendGoOutRecordId 外出打卡记录id
     * @return 外出打卡记录详情
     */
    @ApiOperation(value="根据外出打卡记录id查询外出打卡记录详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendGoOutRecordId", dataType = "String", value = "外出打卡记录id", paramType = "path")
    })
    Result<AttendGoOutRecordVO> findById(String attendGoOutRecordId);


    /**
     * 查询外出打卡记录
     * @param attendGoOutRecordQuery 外出打卡记录查询参数
     * @return page
     */
    @ApiOperation(value="查询外出打卡记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendGoOutRecordQuery", dataType = "AttendGoOutRecordQuery", value = "外出打卡记录查询参数", paramType = "query")
    })
    Result<List<AttendGoOutRecordListVO>> listAll(AttendGoOutRecordQuery attendGoOutRecordQuery);


     /**
     * 分页查询外出打卡记录
     * @param attendGoOutRecordQuery 外出打卡记录查询参数
     * @return page
     */
    @ApiOperation(value="分页查询外出打卡记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendGoOutRecordQuery", dataType = "AttendGoOutRecordQuery", value = "外出打卡记录查询参数", paramType = "query")
    })
    Result<Page<AttendGoOutRecordListVO>> page(AttendGoOutRecordQuery attendGoOutRecordQuery);


}

